Phone - Find customer by phone number

GET 
/v1/restaurants/:id/customers/phone/:phoneNumber

Get the customer details for a given customer phone number.

Request

Path Parameters

id stringrequired

restaurant uuid that needs to be considered for filter

phoneNumber stringrequired

customer phone number that needs to be considered for filter

Responses

200

Successful

*/*

Schema

Schema

customerUuid stringrequired

Customer UUID

firstName string
lastName string
phone stringrequired
email string

nextReservationsList

object[]

required

Array [

reservationUuid stringrequired

reservation uuid

mealDate daterequired

Reservation meal date

status stringrequired

Possible values: [RECORDED, CONFIRMED, CANCELED, NO_SHOW, REQUESTED, REFUSED]

Reservation status

]

Example (from schema)

{
  "customerUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "firstName": "Doe",
  "lastName": "John",
  "phone": "+33612345678",
  "email": "john@example.com",
  "nextReservationsList": [
    {
      "reservationUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "mealDate": "2022-01-03T18:10:17.269Z",
      "status": "RECORDED"
    }
  ]
}

401

Unauthorized

*/*

Schema

Schema

data object
error string

Possible values: [Unauthorized]

statusCode number

Possible values: [401]

Example (from schema)

{
  "data": {},
  "error": "Unauthorized",
  "statusCode": 401
}

404

Not Found

*/*

Schema

Schema

data

object

code string

Possible values: [PHONE_NUMBER_NOT_FOUND]

error string

Possible values: [Not Found]

statusCode number

Possible values: [404]

Example (from schema)

{
  "data": {
    "code": "PHONE_NUMBER_NOT_FOUND"
  },
  "error": "Not Found",
  "statusCode": 404
}

Loading...